Список настроек кост-центров

Центры затрат позволяют получить от сотрудника информацию о рабочей поездке. Все параметры необходимо настроить при создании центра затрат.

Синтаксис запроса

GET https://business.taxi.yandex.ru/api/1.0/client/{идентификатор клиента}/cost_centers 

🔴 Рекомендуем использовать API 2.0. Поддержка API 1.0 в будущем будет прекращена.

Заголовки запроса:

Authorization

OAuth-токен. Процесс получения токена описан в разделе Начало работы.

Пример запроса

GET https://business.taxi.yandex.ru/api/1.0/client/a2...d09/cost_centers

Authorization: <OAuth-токен>

Пример ответа

{
    "items": [
        {
            "id": "1234567890abcdef1234567890abcdef",
            "name": "Основной центр затрат",
            "default": true,
            "field_settings": [
                 {
                   "id": "0123456789abcdef0123456789abcde0",
                   "hidden": false,
                   "title": "Центр затрат",
                   "required": true,
                   "services": ["taxi"],
                   "format": "select",
                   "values": ["командировка", "в центральный офис"]
                 },
                 {
                   "id": "0123456789abcdef0123456789abcde1",
                   "hidden": false,
                   "title": "Цель поездки",
                   "services": ["taxi"],
                   "required": true,
                   "format": "mixed",
                   "values": ["цель 1", "цель 2", "особая цель"]
                 },
                 {
                   "id": "0123456789abcdef0123456789abcde2",
                   "hidden": true,
                   "title": "Номер дела",
                   "services": ["taxi"],
                   "required": true,
                   "format": "text",
                   "values": []
                 }
            ]
        }
    ]
}

Описание полей ответа

Поле Описание Формат
items Список наборов настроек центров затрат. Массив
id id набора настроек центра затрат. Строка
client_id id клиента. Строка
name Название набора настроек центра затрат. Строка
default Является ли набор настроек основным. Логическое
field_settings Список настроек для каждого поля центров затрат. Массив
field_settings.[N].id id поля. Строка
field_settings.[N].title Название поля. Строка
field_settings.[N].required Обязательно ли заполнять это поле при заказе. Логическое
field_settings.[N].hidden Не показывать и не использовать это поле при заказе. Необязательное поле. Логическое
field_settings.[N].services Идентификаторы сервисов, в которых можно использовать это поле при заказе. На данный момент поддерживается только taxi. Массив
field_settings.[N].format Формат указания центра затрат для сотрудника. Возможные значения:
- select — сотрудник выбирает кост-центр из списка.
- text — сотрудник самостоятельно указывает кост-центр в текстовом поле.
- mixed — сотруднику доступны выбор кост-центра из списка и свободный ввод в текстовом поле.
Объект
field_settings.[N].values Cписок кост-центров, доступных для сотрудника. Формат списка "кост_центр1","кост_центр2", ....
Доступен только при значении формата mixed и select.
Объект

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

  • 200 — запрос выполнен успешно.
  • 401 — был передан неверный OAuth-токен.
  • 403 — у клиента не хватает прав на выполнение данного запроса.